Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Indicator documentation notation #353

Merged
merged 5 commits into from
Oct 24, 2022
Merged

Indicator documentation notation #353

merged 5 commits into from
Oct 24, 2022

Conversation

tbalke
Copy link
Contributor

@tbalke tbalke commented Oct 17, 2022

Make class docstrings agree with prox docstrings

Make class docstrings agree with prox docstrings
@tbalke tbalke requested a review from bwohlberg October 17, 2022 16:20
@tbalke
Copy link
Contributor Author

tbalke commented Oct 17, 2022

Equivalently we could change the prox docstrings

@codecov
Copy link

codecov bot commented Oct 17, 2022

Codecov Report

Merging #353 (c5ba0b6) into main (ed1c82f) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #353   +/-   ##
=======================================
  Coverage   94.12%   94.12%           
=======================================
  Files          57       57           
  Lines        3369     3369           
=======================================
  Hits         3171     3171           
  Misses        198      198           
Flag Coverage Δ
unittests 94.12% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
scico/functional/_indicator.py 100.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@bwohlberg bwohlberg added the documentation Improvements or additions to documentation label Oct 24, 2022
bwohlberg
bwohlberg previously approved these changes Oct 24, 2022
@bwohlberg bwohlberg dismissed their stale review October 24, 2022 21:10

Overlooked issue

@bwohlberg
Copy link
Collaborator

There is still a >=0 subscript for the I in the equation for the prox of NonNegativeIndicator.

@tbalke tbalke merged commit 7498b95 into main Oct 24, 2022
@bwohlberg bwohlberg deleted the tbalke-indicator-notation branch October 25, 2022 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants